Table of Contents
Below are frequently asked questions about API.
Select the arrow to reveal the answers to your questions.
API
What is an API?
APIs are mechanisms that enable two software components to communicate with each other using a set of definitions and protocols. We offer two APIs:
- Webhook APIs provide efficient real-time updates
- Traditional REST API for more common queries and programming activities
What is an API token?
An API token (more commonly called a bearer token) is a security token used to authenticate and authorize requests and access to protected resources in web applications and APIs.
The name "bearer authentication" means “give access to the bearer of this token.” We use it with our API to identify and authorize your access.
How do I generate an API token?
NOTE: Document every API token you create so you can quickly delete it should it become compromised.
To delete your API token, select the trash bin icon to the right of the token. This is the button to select should your token become compromised.
API tokens are free! Generate as many tokens as you have partners to minimize your risk if one is leaked.
Follow these steps to find your API token:
- From your portal, select ‘Setup’ from the top toolbar.
- Select ‘API/Developers’ from the left menu.
- Select ‘+ Create New Token.’
Follow these steps to find your host link:
- From the API/Developers page, select the ‘API documentation page’ link.
- Locate your API host link in the middle of the page.
NOTE: The API token and host link are specific to each account.